swagger可以降低我们前后端开发文档同步问题,其能够根据我们的代码注释自动生成API文档,而我们只需简单的运用其注释即可,可视化的呈现程序所有的接口列表,非常方便我们前后端进行接口调试。
The Best APIs are Built with Swagger Tools
Swagger工具可以帮助我们完成生成和维护API文档的工作,确保我们的文档在API发展过程中保持最新状态。
1. 添加Swagger依赖
1 | <!-- swagger --> |
2. 新建SwaggerConfig类
1 |
|
3. 添加文档内容
用于Controller(控制类)
注解 | 作用 |
---|---|
@Api | 将一个类标记为Swagger资源 |
@ApiOperation | 给API增加说明,描述针对特定路径的操作或通常为HTTP方法 |
@ApiResponses | 描述API操作的响应 |
@ApiImplicitParams、 @ApiImplicitParam |
给API参数增加说明。 |
用于model(实体类)
注解 | 作用 |
---|---|
@ApiModel | 注解实体 |
@ApiModelProperty | 定义实体属性 |
4. 访问验证
http://localhost:8080/swagger-ui.html#/
效果如下: